﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once
#include "IPositionAssociatedPlane.h"

namespace gcmp
{
    class IDocument;
    class UniIdentity;
    /// \brief 单个关联平面定位类
    class GCMP_MODEL_INTERFACE_EXPORT IPositionSingleAssociatedPlane : public IPositionAssociatedPlane
    {
        DEFINE_CAST_DERIVED(gcmp::IPositionSingleAssociatedPlane, gcmp::IPositionAssociatedPlane)
    public:
      /// \brief  创建单个关联平面定位对象
      /// \param pElement 元素指针
      /// \param associatedPlaneId 关联平面id 
      /// \param offset 偏移量
      /// \param associatedPlaneParameterUid 关联平面参数GUID
      /// \param offsetParameterUid偏移量参数
      /// \return 单个关联平面定位对象
      static OwnerPtr<IPositionSingleAssociatedPlane> CreateSingleAssociatedPlane(IElement *pElement, const ElementId &associatedPlaneId, double offset, const UniIdentity &associatedPlaneParameterUid, const UniIdentity &offsetParameterUid);
     
      /// \brief 创建底部关联平面定位对象
      /// 
      /// 与CreateSingleAssociatedPlane区别是内部指定了关联平面参数和偏移量参数
      /// \param pElement 元素指针
      /// \param bottomAssociatedPlaneId 关联平面id 
      /// \param offset 偏移量
      /// \return 底部关联平面定位对象
      static OwnerPtr<IPositionSingleAssociatedPlane> CreateBottomAssociatedPlane(IElement *pElement, const ElementId &bottomAssociatedPlaneId, double offset);
      
      /// \brief 创建顶部关联平面定位对象
      /// 
      /// 与CreateSingleAssociatedPlane区别是内部指定了关联平面参数和偏移量参数
      /// \param pElement 元素指针
      /// \param topAssociatedPlaneId 关联平面id 
      /// \param offset 偏移量
      /// \return 顶部关联平面定位对象
      static OwnerPtr<IPositionSingleAssociatedPlane> CreateTopAssociatedPlane(IElement *pElement, const ElementId &topAssociatedPlaneId, double offset);
    
    public:
        /// \brief 得到关联平面id
        /// \return 关联平面id
        virtual ElementId GetAssociatedPlaneId() const = 0;

        /// \brief 设置关联平面id
        /// \param id 关联平面id
        /// \return 返回true表示成功设置，否则表示失败 
        virtual bool SetAssociatedPlaneId(const ElementId &id) = 0;

        /// \brief 得到偏移量
        /// \return 偏移量
        virtual double GetOffset() const = 0;

        /// \brief 设置偏移量
        /// \param value 偏移量
        /// \return 返回true表示成功设置，否则表示失败 
        virtual bool SetOffset(double value) = 0;

        /// \brief 判断是否允许删除关联平面
        /// \return 返回true表示允许删除关联平面，否则表示禁止删除 
        virtual bool IsAllowRemoveAssociatedPlane() const = 0;

        /// \brief 设置是否允许删除关联平面
        /// \param value true表示允许删除关联平面，否则表示禁止删除 
        /// \return 返回true表示成功设置，否则表示失败  
        virtual bool SetIsAllowRemoveAssociatedPlane(bool value) = 0;
    };
}


